Pause an Active Schedule

{ suspendSchedule }

Pauses or suspends the processing of an active schedule

Method

/API2/tasks/suspendSchedule

  • API Section: /API2/tasks
  • API Version: 2.0
  • From Release: 2018.5
  • Usage: REST API only via POST actions.
  • Usage by:
    • Enterprise Admin
  • Input Parameters

    Name

    scheduleId

    Type

    string

    Description

    The schedule's system ID

    Output Response

    Successful Result Code

    200

    Response Type

    Description of Response Type

    Generic API response object with success or failure flag and related messages.

    Examples